Ensure that the Generic module has been enabled in the Idealpos Licence Gateway.

Contact Idealpos or your Idealpos Reseller to purchase this module.

The Generic module needs to be enabled in the Licence Gateway for each POS Terminal that will utilise the Generic Room Interface.

Once the module has been enabled, go to: Back Office > Setup > Licence Gateway and press the "Reload" button.

The Generic module will appear under the list of Options as shown in the example below.

If the Generic module does not appear after pressing the Reload button, contact Idealpos or your Idealpos Reseller.

 

The Generic Room Interface will require a shared network path/location that is accessible to all POS Terminals that will utilise the Generic Room Interface.

The network path can be a shared folder hosted on a server/PC that is turned on at the same time as the POS Terminals are in use.

The network path can be entered as either:

 

• \\HOSTNAME\ShareFolder (substitute the HOSTNAME with the name of the PC or Server hosting the share, and substitute the ShareFolder with the name of the Share)
  E.g. \\BACKOFFICE\PMS
• \\IPADDRESS\ShareFolder (substitute the IPADDRESS with the IP address of the PC or Server hosting the share, and substitute the ShareFolder with the name of the Share).
  E.g. \\192.168.1.1\PMS

 

Once the share has been configured, access to the path can be tested by opening a Windows File Explorer window on the POS Terminals and test entering the path into the address bar.

Note that additional configuration may be required, such as User Accounts and Share Permission configuration. This is outside the scope of the User Guide.

Once configured, take note of the network path, as it will be used when configuring the Generic Room Interface in Global Options below.

The Generic Room Interface will require a Tender to be linked.

This linked Tender Type will be used when posting transactions to the Room/Guest.

 

Go to: Back Office > Setup > Function Descriptors.

Locate the next unused Function Descriptor and configure as follows:

 

• Description: Enter the desired Description for the Tender (e.g. PMS CHARGE, ROOM CHARGE, etc.).

 

 

 

To make the tender visible on the POS Screen, go to: Back Office > Setup > Yes/No Options > Tenders.

Disable the Yes/No Option "Inhibit PMS CHARGE" or "Inhibit ROOM CHARGE".

The Description shown in the Yes/No Option will be reflective of the Description entered for the Function Descriptor.

 

Go to: Back Office > Setup > Global Options > Interfaces > Rooms.

 

• Interface Type: Generic
• Output from POS#: Enter the POS Terminal of the main POS that will handle the outputting of data to the Generic PMS.
• Network Path: Enter the Network Path configured above. Note - Ensure that the entered network path does not contain a backslash at the end of the path as this will prevent the functionality from working successfully.
• Tender Type: Select the PMS CHARGE Tender Type that was configured above.

 

For all the changes to apply, it is recommended that Idealpos is restarted on all POS Terminals and the Back Office.

Go to: Start > Idealpos > IPSUtils > Press "Close" > Confirm.

Start Idealpos via the "Idealpos" desktop shortcut, or go to: Start > Idealpos > Idealpos.

 

Note that a GUEST.DAT file will need to exist for this functionality to work.

Refer to the Additional Information section below for further details.

GUEST.DAT

The Generic Room Interface requires a GUEST.DAT file to function.

The GUEST.DAT must be placed within the network path that was configured above for the Generic Room Interface.

The GUEST.DAT file will store information about Room Numbers/Guests and will be used when tendering to the PMS CHARGE/ROOM CHARGE Tender Type.

The format of the GUEST.DAT is as follows:

RoomNumber,CustomerName,CreditLimit,CurrentBalance,ScanCode

 

Example GUEST.DAT for demonstration purposes

For the purpose of setting up the system for demonstration, a GUEST.DAT can be created as follows and saved into the Network Path configured above.

The information shown in the demo file below translates to the following:

Room 100 has Guest "Joe Blow" staying in the room with a Credit Limit of $1000, a Current Balance of $0 and a Scan Code of 123123123123

Room 101 has Guest "Joanne Blow" staying in the room with a Credit Limit of $1000, a Current Balance of $500 and a Scan Code of 234234234234

 

100,Joe Blow,1000,0,123123123123

101,Joanne Blow,1000,500,234234234234

 

 

CHARGES.DAT

Charges will be posted to the CHARGES.DAT file in the following format:

TransactionType,RoomNumber,CustomerName,Department,GLCode,QTY,Amount,Location,DateStamp,AddOnTaxInUse(0=AddOnTaxInUse,1=AddOnTaxNotInUse),DepartmentTotalAddOnTaxAmount,DepartmentTotalInclusiveTaxAmount,AuditNumber

 

Information about Department Total Add On Tax Amount/Department Total Inclusive Tax Amount:

• DepartmentTotalAddOnTax refers to Add On Tax in regions such as USA, where the Inc checkbox (in Global Options > Sales) can be unchecked for a Tax Rate, which triggers the Tax to be added onto the item at the end of the sale for Stock Items that have the corresponding tax rate enabled. Stock Items that have Add On Tax applied to them will trigger the Total Add On Tax to be populated in the DepartmentTotalAddOnTax field.
• DepartmentTotalInclusiveTax refers to Inclusive Tax, where the Inc checkbox (in Global Options > Sales) is ticked for a Tax Rate, which triggers the Tax to be included in the Stock Item's sell price for Stock Items that have the corresponding tax rate enabled. Stock Items that have Inclusive Tax applied to them will trigger the Inclusive Tax to be populated in the DepartmentTotalInclusiveTax field.
• Inclusive Tax can be used in all regions (in regions such as Australia, all Tax Rates that are configured in Global Options are treated as inclusive and other regions such as USA can use Inclusive Tax by enabling the Inc checkbox in Global Options > Sales for a specific Tax Rate).